Including Help for a Widget

You can include help for any widget that has the help icon ().

The help icon only appears when a user is editing a PageBuilder page. The icon appears both when a user is viewing a widget and editing its properties.

It is not available to a page’s site visitors.

Defining a Widget’s Help File

To create a widget’s help file, follow these steps.

1. Create an HTML file with information for users who will drop the widget on the PageBuilder page.

   You could create a content block within Ektron CMS400.NET then switch to source view, copy the content into a word processor (like Notepad), and save it with an HTML extension.

2. Save the help file to the folder that contains the widget.
3. Add the WidgetHost’s HelpFile property to the codebehind of the page that hosts the widget. See example below.

protected void Page_Init(object sender, EventArgs e)
{
_host = Ektron.Cms.Widget.WidgetHost.GetHost(this);
_host.HelpFile = "~/widgets/myWidget/help.html";